Health Check Service

CMP Converged Monetisation Platform. The MDS Global product that supports customer care and billing for digital service providers. provides a global health check service which it is mandatory for any external load balancer to use to determine the health of instances of CMP modules. The service checks the cmpModuleMaintenance table to determine whether the module is configured to be online, and then checks whether the module is running correctly and able to handle traffic. This allows for modules to be placed into maintenance mode. This can be used by the load balancer and allows any HA deployment to place modules into maintenance mode so that they appear unavailable on the load balancer when upgrading.

It is deployed on the same port (default of 21215) across all of the hosts on which the CMP application is installed.

The global health service can be accessed through the following URI:

where ${hostName} is the host on which the module is deployed and ${moduleName}is the name of the specific module. For example:

The service returns a response such as:

{ "status" : "UP" },

where "status" can be one of "UP", "DOWN", "MAINTENANCE", or "UNKNOWN", for example:

The status of "UNKNOWN" will only be returned for a module that does not have an application specific health check defined.

The global health service is configured in the Global Properties in the inventory. See Installation Configuration Tool for more information.